Skip to content

docs: CCIP per-team style guides#1990

Draft
chris-de-leon-cll wants to merge 3 commits intomainfrom
feat/tooling-style-guides
Draft

docs: CCIP per-team style guides#1990
chris-de-leon-cll wants to merge 3 commits intomainfrom
feat/tooling-style-guides

Conversation

@chris-de-leon-cll
Copy link
Copy Markdown
Collaborator

@chris-de-leon-cll chris-de-leon-cll commented Apr 20, 2026

Summary

Adds three team-owned style guide harnesses under docs/style-guides/ for the CCIP tooling standardization effort. Each file provides structure, cross-links, scope boundaries (platform vs EVM vs ops), a copyable rule template aligned with deployment/docs/style-guide-contributions.md, and directional topic lists for teams to fill in—not substantive rules.

What changed

  • docs/style-guides/platform.md — Chain-agnostic changeset practices (shared shapes, refs, datastore, abstractions, etc.).
  • docs/style-guides/evm.md — EVM-specific changeset authoring (selectors, contract surfaces, adapter usage).
  • docs/style-guides/ops.md — Operating and reviewing work via chainlink-deployments (pipelines, environments, run review).

Each guide links to the other two, to deployment/docs/style-guide.md, and to deployment/docs/style-guide-contributions.md for the shared maintenance pattern.

Why

Reduces implicit knowledge for contributors and reviewers by giving each area a consistent place to capture durable rules over time, without duplicating deployment architecture docs or overlapping concerns across the three guides.

@chris-de-leon-cll chris-de-leon-cll self-assigned this Apr 20, 2026
@github-actions
Copy link
Copy Markdown

Metric feat/tooling-style-guides main
Coverage 70.1% 69.9%

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant